home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / smaltalk / docs.lha / docs / help.eng < prev    next >
Text File  |  1993-07-24  |  14KB  |  370 lines
  1.  
  2.                    Help File for The Archive Server
  3. ============================================================================
  4.  
  5.         First the Credits,
  6.         than a quick pragmatic help section,
  7.         then a more formal and detailed help section.
  8.  
  9. ==========================================================================
  10.  
  11.        Welcome to the University of Illinois's Smalltalk Archive.
  12.  
  13.                 Brought To You By
  14.  
  15.                Professor Ralph E. Johnson
  16.             Graduate Student William E. Voss
  17.  
  18.  
  19.           Additional Goodies Brought To You By
  20.  
  21.             The Manchester Smalltalk Archive
  22.                   Mario Wolczko
  23.                    Alan Wills
  24.  
  25.          The International Smalltalk Association
  26.                 Library Committee
  27.                K. C. Wong (Chair)
  28.  
  29.  
  30.               And Most Importantly
  31.  
  32.        The Numerous Programmers Who Have Made Their Code Available
  33.  
  34. ==========================================================================
  35. The archive server run at st.cs.uiuc.edu was written by Michael DeCorte
  36. with minor local modifications by William Voss.  The original source is
  37. available from archive-server@sun.soe.clarkson.edu.
  38. ==========================================================================
  39. The files under the directory ISA are contributed and maintained by the
  40. "International Smalltalk Association" Library Committee.
  41. If you need to communicate with a human: isa@st.cs.uiuc.edu
  42. ==========================================================================
  43. The directory MANCHESTER is a mirror of the Manchester Smalltalk Archive.
  44. European users should access Manchester directly with the message.
  45.     To: goodies-lib@cs.man.ac.uk
  46.     Subject:    help; index
  47. They also mirror our archive, so you won't be missing anything.
  48. If you need to communicate with a human: lib-manager@cs.man.ac.uk
  49. ==========================================================================
  50. The other directories are maintained here at Illinois.  The files in this
  51. archive are available via anonymous ftp from st.cs.uiuc.edu which is
  52. currently an alias for speedy.cs.uiuc.edu at [128.174.241.10].
  53. They are also available via an email based server.
  54.  
  55.     This document describes the email server.
  56.  
  57. If you need to communicate with a human: archive-management@st.cs.uiuc.edu
  58. ============================================================================
  59.  
  60.               Pragmatic Help Section.
  61.  
  62. ============================================================================
  63.     You have probably figured out by now that this Smalltalk archive
  64.     is available via anonymous ftp at st.cs.uiuc.edu, and via an 
  65.     email server at archive-server@st.cs.uiuc.edu.
  66. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
  67.     You probably received this file because you sent a line containing
  68. help
  69.     to archive-server, or because the server had problems with
  70.     some other request you sent.
  71. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
  72.     To get the list of all files, include the line:
  73. send ls-lR
  74.     as part of your message, or if you are an aspiring guru the lines:
  75. archiver shar
  76. encoder uuencode
  77. encodedsend ls-lR.Z
  78.     which will uuencode an already compressed listing, and place
  79.     it in a shell archive for you.  Note that "archiver" and
  80.     "encoder" should be listed before any "send" lines.
  81. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
  82. Finding Files (Hints)
  83.  
  84.     The file ls-lR contains a recursive directory listing of the
  85.     entire archive.  It is updated every night.  (ls-lR.Z is the same
  86.     file compressed.)
  87.  
  88.     The file MANCHESTER/CATALOGUE contains descriptive information for
  89.     almost every SMALLTALK file in the archive.  It does not list
  90.     files under the ISA directory, and it does not list non-Smalltalk
  91.     files such as those under papers/.  However it does include files
  92.     under st80_r4/ st80_pre4/ and st_v/.  Such files are listed as
  93.     uiuc/st_r4/ uiuc/st80_pre4/ and uiuc/st_v respectively.  The
  94.     other files are all listed relative to MANCHESTER/.
  95.  
  96.     So to get both you would include the lines
  97. send ls-lR
  98. send MANCHESTER/CATALOGUE
  99. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
  100.     Unquestionably the most popular commands are:
  101. send <archive> <file..>
  102. encodedsend <archive> <file...>
  103.     On this system 
  104. archive ::= ISA | MANCHESTER | docs | gnu_st | little_st | papers | 
  105.             st80_pre4 | st80_r4 | st_v | tmp | ts | <white space>
  106. file    ::= filename | directory/<file>
  107. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
  108.     Note that the "encodedsend" command is RECURSIVE.
  109.     So given the ls-lR listing:
  110.  
  111. st80_pre4/Foible/FlowKit:
  112. total 134
  113. -rw-r--r--  1 src           283 Jul  5  1990 FlowKit2-PP.bld
  114. -rw-r--r--  1 src          1620 May 14  1990 FlowKit2-PPfix.st
  115.  
  116.     The following commands should be roughly equivalent
  117. encodedsend st80_pre4/Foible/FlowKit
  118.     or
  119. encodedsend st80_pre4 Foible/FlowKit
  120.     or the two line
  121. encodedsend st80_pre4/Foible/FlowKit/FlowKit2-PP.bld
  122. encodedsend st80_pre4/Foible/FlowKit/FlowKit2-PPfix.st
  123.     or the two line
  124. encodedsend st80_pre4 Foible/FlowKit/FlowKit2-PP.bld
  125. encodedsend st80_pre4 Foible/FlowKit/FlowKit2-PPfix.st
  126.  
  127.     However, this is not equivalent
  128. encodedsend st80_pre4 Foible FlowKit/FlowKit2-PP.bld
  129. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
  130.     You will often see listings like this:
  131.  
  132. st80_pre4/Foible:
  133. total 759
  134. drwxr-xr-x  3 src           512 Mar 14 00:15 FlowKit
  135. -rw-r--r--  1 src         57257 Mar 14 00:22 FlowKit.tar.Z
  136.  
  137.     The FlowKit.tar.Z file is a compressed tar of the
  138.     FlowKit directory.  Either get one or the other,
  139.     there should be no need to get both.
  140. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
  141.     So bringing all that together, if you want to
  142.     fetch the FlowKit.tar.Z file send the message.
  143.  
  144. To: archive-server@st.cs.uiuc.edu
  145. Subject:
  146.  
  147. path yourname@your.internet.address
  148. archiver tar
  149. encoder uuencode
  150. encodedsend st80_pre4/Foible/FlowKit.tar.Z
  151. size 100000
  152. ============================================================================
  153.  
  154.         Long more formal version of help.
  155.  
  156. ============================================================================
  157. Copyright 1989, 1990 Michael DeCorte
  158. Modified 1991,1992 by Bill Voss for the st.cs.uiuc.edu Smalltalk archive.
  159. ============================================================================
  160. The archive server is a program that gives you the ability to retrieve
  161. files via electronic mail.  It is a very dumb program with little
  162. error detection. Thus if you make mistakes, you won't get what you
  163. wanted.  This also means that you can ask it to do unreasonable
  164. things, but please don't.
  165.  
  166. To make the archive server do something you should send an electronic
  167. mail message to archive-server@st.cs.uiuc.edu  The body of the message 
  168. should consist of one command per line. The case of the commands does 
  169. not matter.
  170.  
  171. The archive is grouped together via directories.  Each directory is
  172. considered an archive.  Associated with each archive is an index file 
  173. as well as a top level index file that lists all of the archives.  
  174. You can find out what archives are available with the command "index."
  175.  
  176. Supported commands:
  177.  
  178.   help
  179.  
  180.     Sends you this file.
  181.  
  182.   path <mail-path>
  183.  
  184.     "Path" is used to override the mail path that the archive server
  185.     chooses from the header of your mail message.  You should use this
  186.     whenever you know that the return address of your message will not
  187.     be useful to the archive server.  The archive server only knows
  188.     about domain style address.  This means that the archive-server
  189.     understands name@site.bitnet and name@site.edu and name@site.UUCP
  190.     but does not understand name@site.  If you have any doubts about
  191.     your mail address, you should ask your system administrator for a
  192.     correct domain style address.  An example use of "path" is
  193.  
  194.        path mrd@sun.soe.clarkson.edu
  195.  
  196.   index [archive...]
  197.  
  198.     "Index" mails to you a listing of the files in the specified
  199.     archives.  If an archive is not specified, then the index of the
  200.     available archives will be sent.
  201.     The command "send ls-lR" will send a recursive listing of the
  202.     entire st.cs.uiuc.edu archive.
  203.  
  204.   send <archive> <file..>
  205.  
  206.     "Send" mails to you the files in the specified archive.  All of
  207.     the files that you request will be sent to you archived together
  208.     (see "archiver"), possibly packed (see "pack"), possibly encoded
  209.     (see "encoder") and split up into messages that are small enough
  210.     to be mailed (see "size").  If you specify an archive and do not
  211.     specify any files, then all of the files in that archive will be
  212.     sent.  You may have as many "sends" in the body of your mail
  213.     message as you wish.  If you can use one of the "encoders" you
  214.     should always use encodedsend instead.
  215.  
  216.   encodedsend <archive> <file...>
  217.  
  218.     "Encodedsend" is identical to the command "send" except that the
  219.     files are guaranteed to be encoded (see "encoder").  This is
  220.     useful if you know that the return message will go through EBCDIC
  221.     based computers.
  222.  
  223.   archiver <archiving-method>
  224.  
  225.     You may specify the method of archiving (merging a group of files
  226.     into one large file) the files with "archiver".  By default, files
  227.     that are mailable are simply stuck together with the text "cut
  228.     here" between files and; non-mailable files are archived via unix
  229.     tar.  The available archiving methods are:
  230.  
  231.       none (the files are simply stuck together)
  232.       shar (Unix sh script)
  233.       simple (the files are separated by "cut here" - default)
  234.       tar (Unix Tar - default and suggested for non mailable files) 
  235.  
  236.   pack <packing-method>
  237.  
  238.     You may specify that the files be packed (compressed) before
  239.     delivery.  This has the advantage that the mail files will be
  240.     smaller.  By default the files are not packed. The available
  241.     packing methods are:
  242.  
  243.      compress    (the Unix command compress)
  244.      compact     (the Unix command compact - slower than compress)
  245.      none
  246.  
  247.   encoder <encoding-method>
  248.  
  249.     Non-mailable files must be converted to something mailable.  By
  250.     default this is done with "uuencode".  You may also specify that
  251.     the files must be encoded with the command "encodedsend."  The
  252.     available encoding methods are:
  253.  
  254.       btoa
  255.       uuencode (default)
  256.  
  257.   size <max-file in bytes>
  258.  
  259.     The archive server splits files up so that they are smaller than
  260.     this limit.  This is done because many sites have a maximum mail
  261.     size limit.  A value of 0 means that there is no limit.  The
  262.     archive server has a default size limit of 100000 bytes.  You may
  263.     change this if you know that you have different limits.  Most (but
  264.     not all) uucp sites have a limit of 100000 bytes.  Internet and
  265.     Bitnet sites should set this to 300000 bytes.
  266.  
  267.   length <number>
  268.  
  269.     Many mailers will truncate long lines.  To overcome this the
  270.     archive server encodes files that contains lines that are longer
  271.     than 130 characters (see "encoder").  If you know that your mail
  272.     files will not be truncated then you can set this value to
  273.     something larger.
  274.  
  275.   limit <number>
  276.  
  277.     The archive-server limits the amount of data that will be returned
  278.     by any one request.  This limit is very large.  By using this command
  279.     you may lower this limit.  This is typically done to prevent errors
  280.     by the user.
  281.  
  282.   search <string> <archive> <file...>
  283.  
  284.     You may search through the archive for a string.  A string is
  285.     considered to be any sequence of alphanumeric characters; case
  286.     does not matter.  If you only provide an archive name then all of
  287.     the files in the archive will be searched.  You will be returned
  288.     all lines that contain the string.
  289.  
  290.   find  <string...>
  291.     
  292.     You may search for file names that contain the given string.  Case
  293.     is significant in the string.  You will be returned all file names
  294.     that match the given string.
  295.  
  296.   language <string>
  297.  
  298.     This will allow you to change the language that the help files are in
  299.     to the named language.  English is the only supported language right
  300.     now though so this command doesn't really do anything yet.  
  301.     
  302.  
  303.                                EXAMPLE
  304.  
  305. Here is an example message that you could send to the archive-server.
  306. It gives (a somewhat absurd) example of all the supported commands.
  307.  
  308. ------
  309. help
  310. language english
  311. path mrd@sun.soe.clarkson.edu
  312. index st80_pre4
  313. archiver tar
  314. pack compress
  315. encoder btoa
  316. encodedsend gnu_st/smalltalk-1.1.tar.Z
  317. size 200000
  318. length 80
  319. search resume texhax texhax.89.001 texhax.89.002
  320. find resume
  321. -----
  322.  
  323. A more realistic example for users with access to UNIX based systems is.
  324.  
  325. ------
  326. path yourname@your.internet.address
  327. archiver tar
  328. encoder uuencode
  329. pack compress
  330. encodedsend st80_r4
  331. encodedsend MANCHESTER/manchester/4.0
  332. ------
  333. For this example, you would then need to combine the messages you receive 
  334. into a single file, and edit the line which reads something like
  335.         begin 666 1206.outgoing
  336. to instead read
  337.         begin 666 1206.tar.Z
  338.  
  339. As you probably realize, you then
  340.         uudecode your_concatenated_file
  341.         uncompress 1206.tar.Z
  342.         tar -xvf 1206.tar
  343. ============================================================================
  344.  
  345.                                APPENDIX
  346.  
  347. 1) Files are considered mailable if they do not have any lines longer
  348. than 130 characters and do not have any characters other than tabs,
  349. carriage returns, newlines, vertical tabs, formfeeds and characters
  350. between space through tilde (using ascii ordering).
  351.  
  352. 2) If you have problems or questions, you should send mail to
  353. archive-management@st.cs.uiuc.edu.
  354.  
  355. 3) If you have an archiving, packing, encoding program that runs under
  356. BSD Unix that I do not have and you would like me to support then
  357. please send it to me.  It is very easy to incorporate it into this
  358. package.
  359.  
  360. 4) The archive server was written by Michael DeCorte.  It consists of
  361. a groups of bourne shell and awk scripts designed to work under BSD
  362. Unix based computers. There are no restrictions on its redistribution
  363. provided the copyright notice is left intact.
  364.  
  365. 5) Send mail to archive-server@sun.soe.clarkson.edu if you want the
  366. original archive-server source.
  367.  
  368. 6) Unix is a registered trademark of AT&T.
  369. ============================================================================
  370.